home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / cnet / lastcallers_85.lha / LastCallers / LastCallers.doc < prev    next >
Text File  |  1995-05-17  |  21KB  |  471 lines
  1.                             LastCallers v8.2
  2.                        For C-Net Amiga ** v3.04+ **
  3.                    Written by Ray Akey (AKA Heavy Metal)
  4.  
  5.        This is an enhanced Last 10 callers program for C-Net Amiga.
  6.  
  7.  
  8.  
  9. Current Changes (v8.5)
  10. ----------------------
  11. 1. LastCallers now uses a method of mutual exclusion so that when one port is
  12.    updating LastCallers data, another cannot access it until the port owning
  13.    the lock frees it.  This fixes the previous crashing problem and also the
  14.    rare but annoying problem that corrupted LastCallers data files.
  15.  
  16. 2. Network calls are now logged using "LastCallersNet".  LastCallersNet
  17.    is a DOS program that updates the LastCallers data file with the network
  18.    node's NODE NUMBER, CONNECT BAUDRATE and PORT NUMBER. 
  19.  
  20.    The syntax of the LastCallersNet program is as follows:
  21.  
  22.       LastCallersNet NODENUMBER BAUDRATE PORTNUMBER
  23.  
  24.    Here is an example TRAPDOOR aftersession script that also runs CNet Toss:
  25.  
  26.       =============== contents of Mail:AfterSession.script ===================
  27.       .key NODENUMBER,BAUDRATE
  28.       .bra {
  29.       .ket }
  30.  
  31.        if {NODENUMBER}
  32.           LastCallersNet {NODENUMBER} {BAUDRATE} 1
  33.       endif
  34.       TOSS verbosity 1
  35.       ================ end of sample script ==============
  36.  
  37.    If you install an eftersession script, don't forget to add the following
  38.    line to your trapdoor.cfg:
  39.  
  40.       AFTERSESSION "c:runback >NIL: c:EXECUTE Mail:AfterSession.script %n %B"
  41.  
  42.       note: Trapdoor expands the %n in the line above to the calling node's
  43.             node number.
  44.             Trapdoor also expands the %B to the calling node's CONNECT baud-
  45.             rate.
  46.  
  47.  
  48. Changes v8.4
  49. ------------
  50. 1. Added "LastCallersScr" to systext: so that status displays and the newly
  51.    added "records" could be set up for optimum viewing.  Also see Line 61 and
  52.    62 of LastCallersText.
  53.  
  54.       LastCallersScr (default filename; configurable in LastCallersText) is a
  55.    crude script file that is capable of ALL CNet MCI/ANSI commands PLUS an
  56.    added bonus of parsing ALL of the variables that LastCallers uses, via
  57.    tokens.  Anything in curly braces {} is considered a LastCallers token and
  58.    will be removed and converted, if valid, to LastCallers tokens.  CTRL-Q
  59.    and CTRL-Y begin, of course, CNet MCI commands.
  60.       LastCallersScr is parsed and displayed in either of two places, your
  61.    choice;  BEFORE the last x callers are displayed or after.  If you want it
  62.    displayed before, put the name of the text/script file on line 61 of
  63.    LastCallersText.  To have the text displayed after the last callers, put
  64.    the filename, of the file to display, on line 62.  You can use both if
  65.    you wish.  If you want NOTHING displayed before or after the last callers
  66.    leave lines 61 and 62 of LastCallersText blank.
  67.  
  68. 2. Added "RECORD" variables.  The new token names and their appropriate
  69.    arguments are listed below.
  70.  
  71.    NOTE: A few of these new tokens accept a THIRD argument. When a third
  72.          argument is required, it is used as in the following example:
  73.  
  74.          {REC_DAYCALLSD %8.8s 1}
  75.  
  76.          The third argument, above, is the "1" before the closing brace. With
  77.          DATE oriented tokens, the third argument will be your signal to
  78.          LastCallers that you wish to use the SHORT date format.  A "2" as
  79.          the third argument tells the program that you want the LONG date
  80.          format.  Other token uses for this newly implemented third argument
  81.          may be added in the future.
  82.  
  83.          TOKEN/Explanation   C Formatter    Third Argument & options
  84.          ------------------- -------------- -----------------------------
  85.          REC_DAYCALLS        %s             NONE
  86.          Record Calls/day
  87.  
  88.          REC_DAYCALLSD       %s             1 = SHORT (DD-MM-YY) date
  89.          Record Calls/Date                  2 = LONG (DD-MON-YY) date
  90.          This is the date
  91.          the record was acheived
  92.  
  93.          REC_UPFILE          %s             NONE
  94.          Record Upfiles
  95.  
  96.          REC_UPFILED         %s             1 = SHORT (DD-MM-YY) date
  97.          Record UpFiles/Date                2 = LONG (DD-MON-YY) date
  98.  
  99.          REC_UPK             %s             NONE
  100.          Record Up KBytes
  101.  
  102.          REC_UPKD            %s             1 = SHORT (DD-MM-YY) date
  103.          Record UpK/Date                    2 = LONG (DD-MON-YY) date
  104.  
  105.          REC_DOWNFILE        %s             NONE
  106.          Record Down'd files
  107.  
  108.          REC_DOWNFILED       %s             1 = SHORT (DD-MM-YY) date
  109.          Record DownFiles/Date              2 = LONG (DD-MON-YY) date
  110.  
  111.          REC_DOWNK           %s             NONE
  112.          Record Down'd KBytes
  113.  
  114.          REC_DOWNKD          %s             1 = SHORT (DD-MM-YY) date
  115.          Record DownK/Date                  2 = LONG (DD-MON-YY) date
  116.  
  117.          REC_MINSON          %s             NONE
  118.          Record Minutes Online
  119.  
  120.          REC_MINSOND         %s             1 = SHORT (DD-MM-YY) date
  121.          Record Minutes/Date                2 = LONG (DD-MON-YY) date
  122.  
  123.          REC_CALLS           %s             NONE
  124.          Record Calls
  125.  
  126.          REC_CALLSD          %s             1 = SHORT (DD-MM-YY) date
  127.          Record Calls Date                  2 = LONG (DD-MON-YY) date
  128.  
  129.          REC_PUBMSG          %s             NONE
  130.          Record Public Messages
  131.  
  132.          REC_PUBMSGD         %s             1 = SHORT (DD-MM-YY) date
  133.          Record PubMsg Date                 2 = LONG (DD-MON-YY) date
  134.  
  135.          REC_PRIMSG          %s             NONE
  136.          Record Private Messages
  137.  
  138.          REC_PRIMSGD         %s             1 = SHORT (DD-MM-YY) date
  139.          Record PriMsg Date                 2 = LONG (DD-MON-YY) date
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146. Changes v8.2
  147. -------------
  148. 1. VERBOSE mode got some needed internal attention.
  149. 2. Fixed NOLOGMAINTUSER and LOGMAINTUSER keywords:  were not being recognized
  150.    properly.
  151. 3. sysdata:LastCallersText2 line 46 was displayed for ALL gfx/termwidth types
  152.    rather than choosing the proper line (45-50).  Thanks to PMK on Future
  153.    World for this bug report.
  154. 4. New token types for LastCallersText2:
  155.  
  156.       {ONTIME %s}
  157.       {ONDATE %s}
  158.       {OFFTIME %s}
  159.       {OFFDATE %s}
  160.  
  161. 5. {CALLSTODAY} is now a string type, so the following format is correct:
  162.  
  163.       {CALLSTODAY %s}
  164.  
  165.  
  166.  
  167. Changes v8.1
  168. -----------
  169. 1. {REALNAME} added to the list of possible tokens available for
  170.    LASTCALLERSTEXT2.
  171. 2. The following configuration keywords added.  The following is an exact
  172.    duplicate of explanation for each as found in Last10.cfg:
  173.  
  174.                VERBOSE           -> Verbose (debug) output to user's screen
  175.                                     this option only works if the user has
  176.                                     SYSOP MAINT - otherwise ignored
  177.                NOLOGID x         -> Don't log account x
  178.                NOLOGNAME x       -> don't log handle x
  179.                NOLOGACCESS x     -> don't log access x
  180.  
  181. ;----------- -> SHOWNUM x        -> Show last x callers (this is also used to
  182. ;IF USED,    ->                     determine the number of entries logged to
  183. ;THESE THREE ->                     Last10.data.
  184. ;OPTIONS MUST-> ADJUST x         -> Adjust users TermLength by this number
  185. ;EXIST IN    ->                     (added to facilitate other mods to text)
  186. ;LAST10.CFG  ->                     Increase or decrease until Top Ten fits
  187. ;IN THIS     ->                     on user's screen when using USETERMLEN
  188. ;ORDER!      ->                     default ADJUST = 11.
  189. ;----------- -> USETERMLEN       -> Use the user's TERMLENGTH to determine
  190. ;----------- ->                     number of last callers to display
  191.  
  192.  
  193.    NOTE: "SHOWNUM x" will always be used to set the number of entries that
  194.         will be logged into the last ten data.  For this reason, if SHOWNUM
  195.         is not configured, the user will see ONLY the last ten callers by
  196.         default as that is how many callers will be logged to last 10 data
  197.         in that case.  Also note that the USETERMLEN option must exist
  198.         before (above) the SHOWNUM x option in this cfg file, if that option
  199.         is used.  Also if "ADJUST x" is to be used, it must exist above
  200.         USETERMLEN.
  201.  
  202.          ie. If SHOWNUM 40 is set, and a user's terminal length is set
  203.         to 23, the user may only see the last 19 callers but 40 entries
  204.         will actually exist in the Last10.data
  205.  
  206. Changes v8.0
  207. -----------
  208. 1.  Token interpreter added that allows you to choose exactly what you want
  209.     displayed and how you want it displayed!!
  210.  
  211.    Choice of the following currently existing variables:
  212.  
  213.    USER Variable Name       TYPE            Explanation
  214.    ------------------------ --------------- ---------------------------------
  215.    {HANDLE}                 %s              user's handle (doh)
  216.    {REALNAME}               %s              user's real name
  217.    {CITY}                   %s              user's City & State
  218.    {COUNTRY}                %s              user's Country
  219.    {PORTNUM}                %d              Port number user occupied
  220.    {BAUD}                   %d              user's login baud
  221.    {CALLERNUM}              %ld             the caller number the user was
  222.    {DOWNFILES}              %d              the number of files users has dloaded this call
  223.    {DOWNK}                  %ld             number of KILObytes user has dloaded this call
  224.    {UPFILES}                %d              the number of files users has uploaded this call
  225.    {UPK}                    %ld             number of KILObytes user has uploaded this call
  226.    {MINSON}                 %d              number of minutes user was online
  227.    {CALLSTODAY}             %s              Number of calls the user made to the
  228.                                             system (the day he/she logged in!)
  229.    {TOTALCALLS}             %d              total number of calls the user has
  230.                                             made to the system
  231.    {AGCNAME}                %s              user's access group name
  232.    {PUBMSGS}                %d              number of PUBLIC msgs user made to
  233.                                             the system
  234.    {PRIMSGS}                %d              number of PRIVATE msgs user made to
  235.                                             the system
  236.    {BANNER}                 %s              Users system banner
  237.    {ACCOUNTNUM}             %d              users account number
  238.  
  239.  
  240.    SYSTEM STAT Variable Name    TYPE SPECIFIER  Explanation
  241.    ---------------------------- --------------- -----------------------------
  242.    {TSYSCALLS}                  %ld             Calls to the system TODAY
  243.    {TSYSUPF}                    %d              number of files uploaded to
  244.                                                 the system today
  245.    {TSYSUPK}                    %ld             number of K-bytes upload today
  246.    {TSYSDNF}                    %d              number of files downloaded
  247.                                                 today
  248.    {TSYSDNK}                    %ld             number of K-BYTES downloaded 
  249.                                                 today
  250.    {SSYSCALLS}                  %ld             TOTAL calls to the system
  251.    {SSYSUPF}                    %ld             TOTAL files uploaded
  252.    {SSYSUPK}                    %ld             Total K-bytes uploaded/1000
  253.    {SSYSDNF}                    %ld             total files downloaded
  254.    {SSYSDNK}                    %ld             total K-bytes downloaded/1000
  255.    {YSYSCALLS}                  %ld             calls to the system testerday
  256.    {YSYSUPF}                    %ld             files uploaded yesterday
  257.    {YSYSUPK}                    %ld             K-bytes uploaded yesterday
  258.    {YSYSDNF}                    %ld             files downloaded yesterday
  259.    {YSYSDNK}                    %ld             K-bytes downloaded yesterday
  260.    {AUTHOR}                     %s              ME! (Heavy Metal/NORML)
  261.    {ACTION}                     %s              String of actions the user
  262.                                                 performed online
  263.  
  264.    The format for these variables is as follows:
  265.  
  266.    {AUTHOR %s}
  267.  
  268.     ^^^^^^ ^^
  269.       |     |
  270.       |     c formatting specifier
  271.       variable name
  272.  
  273.    Your variable name MUST be enclosed in braces.
  274.  
  275.    More about C formatting specifiers:
  276.  
  277.       You may also use any of the following formats for your C specifiers
  278.  
  279.          %12s                Means print the variable as a STRING in a field
  280.                              of 12 characters RIGHT justified and padded with
  281.                              spaces.
  282.          %-12s               Means print the variable as a STRING in a field
  283.                              of 12 characters LEFT justified and padded with
  284.                              spaces
  285.          %12.11s             Means print the variable as a STRING in a field
  286.                              of 12 characters RIGHT justified and padded with
  287.                              spaces and if the string is longer than 11
  288.                              characters, truncate it at the 11th character
  289.          %5d                 print the variable as an integer in a field of
  290.                              width 5.
  291.          %4ld                Print the variable as a LONG integer in a field
  292.                              of width 4.  If you are getting strange values
  293.                              with %d, try %ld
  294.  
  295.    If you have any suggestions on other variables you would like to see
  296.    added or if you have suggestions, please let me know.
  297.  
  298.  
  299. Changes v7.4
  300. ------------
  301. 1.  LastCallers now logs the last callers from bottom to top.
  302.     The last caller is displayed at the TOP of the last 10 display.
  303. 2.  NOLOGMAINTUSER fixed.  Previously, this did not work properly.
  304.  
  305.  
  306. Changes v7.2
  307. ------------
  308. 1.  Small bug fix involving display of file/byte stats.
  309. 2.  Recompiled with CNet v3.04 headers
  310.  
  311. Changes from v7.1
  312. ------------------
  313. 1.  Can now be used in ANY CLI/Shell -> Caller info only displayed. No
  314.                                         system stats are yet available here.
  315.                                         No last caller data is updated.
  316.  
  317. Changes from V7.0
  318. -----------------
  319. 1.  Now PURE.  Both modules can be made resident.
  320.  
  321.     Use "RESIDENT PFILES:LASTCALLERS PFILES:LASTCALLERS"
  322.     and "RESIDENT PFILES:LASTCALLERSUPDATE PFILES:LASTCALLERSUPDATE"
  323.     in your startups to make either of these programs resident.
  324.  
  325. 2.  It is Now possible to turn OFF/ON sysop account logging and
  326.     any other maint (SYSOP MAINTENANCE priviledge) user.
  327.     To use these options, create the file SYSDATA:LAST10.CFG and place
  328.     any of the following keywords in that file:
  329.  
  330.       NOLOGSYSOP         -> Turns OFF (disbales) logging of account #1 to
  331.                             last 10.
  332.       LOGSYSOP           -> Turns ON (enables) logging of account #1 in last
  333.                             10.
  334.       NOLOGMAINTUSER     -> Turns OFF logging of any users with MAINT (except
  335.                             account #1).
  336.       LOGMAINTUSER       -> Turns ON logging of maint users (except account
  337.                             #1).
  338.  
  339.    NOTE: any commented lines must BEGIN with a semi-colon (;).
  340.          an example LAST10.CFG has been provided.
  341.  
  342.  
  343. Changes from 6.0
  344. ----------------
  345. 1. Major changes (again) for this version.  You must (if they exist) delete:
  346.  
  347.    SYSDATA:LAST10.DATA
  348.          &
  349.    SYSDATA:LAST10.STAT
  350.  
  351. 2. A few DAILY items are kept track of now also:
  352.  
  353.    1:  Calls today.
  354.    2:  Upload Files Today.
  355.    3:  Upload KB Today.
  356.    4:  Dload Files Today.
  357.    5:  Dload KB Today.
  358.  
  359.    All of these "daily" variables are reset each day, after midnight when
  360.    "LastCallersUpdate" is next ran.
  361.  
  362. 3. All text is still capable of being edited so I will leave you here.  Make sure
  363.    you read the "Changes from 5.0" below the sample output, if you are running
  364.    a version that doesn't include the LastCallersUpdate program.
  365.  
  366. 5. The display has been COMPLETELY reworked this time allowing more important
  367.    info to be displayed for each last caller.  Here is a sample output (sans
  368.    colour of course and using IBM GFX):
  369. ---
  370.  
  371.   <>*<>              C-Net LastCallers - Heavy Metal/NORML              <>*<>
  372.  
  373.   P# Handle/Name           Actions Bd  From                 Min   UpK   DnK
  374.   ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ 
  375.    1 Juan Epstein          [----N]  96 Windsor, ON            1     0     0
  376.    1 Dr.doom               [M---N] 144 Windsor Ontario        7     0     0
  377.    1 Black Light           [----N] 144 Windsor,Ontario       14     0     0
  378.    2 Eric                  [----N]  24 Aburg, ON              1     0     0
  379.    1 Supreme Wizard        [---DN] 144 Windsor, ON           47     0  4406
  380.    1 Maxcon                [----N] 144 Windsor, ON            0     0     0
  381.    1 The Urscumug          [M---N]  24 Windsor, ON            7     0     0
  382.    1 Outlaw                [M---N]  96 Windsor, ON            9     0     0
  383.    1 Foxx/norml            [----N] 144 Windsor, ON            2     0     0
  384.    3 Baroness              [-P---]  96 Windsor, ON           12     0     0
  385.   ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ
  386.      [M]sg Left                                             [C]arrier Lost
  387.      [P]aged Sysop          [U]L'ed           [D]L'ed       [N]ormal Off
  388.  
  389.                               Calls   ULf    UpK     DLf    DnK
  390.                       Today:      0     0      0       0      0
  391.                       ToTal:  42715  1711   455K   10863  2662K
  392. ---
  393.  
  394.  
  395. Changes from 5.0
  396. ----------------
  397.  1.   Almost all text is now external, in two files:
  398.  
  399.                           systext:lastcallerstext
  400.                                      &
  401.                           systext:lastcallers.msg
  402.  
  403.       "lastcallers.msg" is just a menu type TEXT file that explains what the
  404.     "action" flags mean.
  405.  
  406.       "lastcallerstext" is the file which contains the actual graphics
  407.     and text/C formatting that is seen when LastCallers is viewed.  Edit this
  408.     file if you wish to customize the Last callers display.  There are
  409.     graphics sections for 40/80 column ASCII, 40/80 column C64 GFX, and 40/80
  410.     column IBM GFX.  The first is IBM, 2nd is CBM and the last but not least,
  411.     ASCII.
  412.  
  413.  2.   The action flags - These are a set of 9 letters which stand for the 
  414.     following things which a user has done while online:
  415.  
  416.                            D = Downloaded
  417.                            U = Uploaded
  418.                            M = Left a message (Mail, Post, Response)
  419.                            P = Paged Sysop
  420.                            C = Lost Carrier
  421.                            N = Normal Logoff
  422.  
  423.  3.   The main display is updated at login, so that the user appears in
  424.     the lastcallers display, in the correct order of logins.  To facilitate
  425.     the updating of the caller display, and to incorporate any actions that
  426.     a user performs while online, the program "LastCallersUpdate" has been
  427.     written.  This C-Net Pfile must be configured to run when a user logs off.
  428.     To do this, add the following command to line 99 of BBSTEXT:
  429.  
  430.     #2pfiles:LastCallersUpdate}
  431.  
  432.     ^
  433.     |
  434.     CTRL-Q
  435.  
  436.  
  437. Operation:
  438. ----------
  439.    The display is nicely formatted and displays correctly for all terminal types
  440. and graphics settings of C-Net Amiga..  It is an all-in-one program where there
  441. is nothing for you to create.  Everything (creation of the data file, updating
  442. last 10 and displaying last 10) is done in a single program.
  443.  
  444. Installation:
  445. -------------
  446.  1.   Copy LastCallers & LastCallersUpdate to your Pfiles.
  447.  2.   add the following text to your SYSTEM:SYS.WELCOME file or another location
  448.       where you would like it displayed..  possibly BBSTEXT but be careful
  449.       where you put it as in some areas of BBSTEXT, the user's handle is not
  450.       know and will show in the Top Ten as <Logon>.  If you put it in
  451.       sys.welcome, it is guaranteed to work FLAWLESSLY.
  452.  
  453.          \#2pfiles:LastCallers\
  454.  
  455.  3.   Add the following text to line 99 of BBSTEXT:
  456.  
  457.          #2pfiles:LastCallersUpdate}
  458.  
  459.          ^
  460.          |
  461.          CTRL-Q
  462.  
  463.  3.   That's it.. When the file is run for the first time, it will create the
  464.       data file and keep it updated on succesive calls.
  465.  
  466.  --------------------------------------------------------------------------
  467.    Call:  THE METAL SHOPPE BBS for more C-Net Pfiles by myself and others
  468.    (519) 256-0278 -- 2400-19200 Baud --           Windsor, Ontario Canada
  469.    (519) 255-7378 -- 1200-2400  Baud --       METAL SOFTWARE HEADQUARTERS
  470.  --------------------------------------------------------------------------
  471.